From 8319585673632a67ec130de3a9c5c71db1da8c5c Mon Sep 17 00:00:00 2001 From: =?utf8?q?Javier=20Jard=C3=B3n?= Date: Thu, 13 May 2010 03:23:30 +0200 Subject: [PATCH] Move documentation to inline comments: GtkToggleAction --- docs/reference/gtk/tmpl/.gitignore | 1 + docs/reference/gtk/tmpl/gtktoggleaction.sgml | 103 ------------------- gtk/gtktoggleaction.c | 21 +++- 3 files changed, 20 insertions(+), 105 deletions(-) delete mode 100644 docs/reference/gtk/tmpl/gtktoggleaction.sgml diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore index b0ce616634..85e880b6bb 100644 --- a/docs/reference/gtk/tmpl/.gitignore +++ b/docs/reference/gtk/tmpl/.gitignore @@ -7,4 +7,5 @@ gtkpagesetupunixdialog.sgml gtkseparator.sgml gtktesting.sgml gtktextiter.sgml +gtktoggleaction.sgml gtktoolitem.sgml diff --git a/docs/reference/gtk/tmpl/gtktoggleaction.sgml b/docs/reference/gtk/tmpl/gtktoggleaction.sgml deleted file mode 100644 index 79a2455e31..0000000000 --- a/docs/reference/gtk/tmpl/gtktoggleaction.sgml +++ /dev/null @@ -1,103 +0,0 @@ - -GtkToggleAction - - -An action which can be toggled between two states - - - -A #GtkToggleAction corresponds roughly to a #GtkCheckMenuItem. It has an -"active" state specifying whether the action has been checked or not. - - - - - - - - - - - - - - - -The GtkToggleAction struct contains only -private members and should not be accessed directly. - - - - - - - - -@toggleaction: the object which received the signal. - - - - - - - - - - - - - - - - -@name: -@label: -@tooltip: -@stock_id: -@Returns: - - - - - - - -@action: - - - - - - - -@action: -@is_active: - - - - - - - -@action: -@Returns: - - - - - - - -@action: -@draw_as_radio: - - - - - - - -@action: -@Returns: - - diff --git a/gtk/gtktoggleaction.c b/gtk/gtktoggleaction.c index 6e464d72e9..5a144bb42d 100644 --- a/gtk/gtktoggleaction.c +++ b/gtk/gtktoggleaction.c @@ -39,6 +39,17 @@ #include "gtkprivate.h" #include "gtkalias.h" + +/** + * SECTION:gtktoggleaction + * @Short_description: An action which can be toggled between two states + * @Title: GtkToggleAction + * + * A #GtkToggleAction corresponds roughly to a #GtkCheckMenuItem. It has an + * "active" state specifying whether the action has been checked or not. + */ + + enum { TOGGLED, @@ -120,7 +131,13 @@ gtk_toggle_action_class_init (GtkToggleActionClass *klass) P_("If the toggle action should be active in or not"), FALSE, GTK_PARAM_READWRITE)); - + /** + * GtkToggleAction::toggled: + * @toggleaction: the object which received the signal. + * + * Should be connected if you wish to perform an action + * whenever the #GtkToggleAction state is changed. + */ action_signals[TOGGLED] = g_signal_new (I_("toggled"), G_OBJECT_CLASS_TYPE (klass), @@ -275,7 +292,7 @@ gtk_toggle_action_set_active (GtkToggleAction *action, * @action: the action object * * Returns the checked state of the toggle action. - + * * Returns: the checked state of the toggle action * * Since: 2.4 -- 2.30.2